API Documentation
Public Member Functions | List of all members
nkWinUi::ImageDisplay Class Reference

Allows to display an image in the Ui. More...

Inheritance diagram for nkWinUi::ImageDisplay:
nkWinUi::Component nkExport::Exportable

Public Member Functions

 ImageDisplay (MainSystem *parentSystem)
 
virtual ~ImageDisplay ()
 
ImagegetImage () const
 
IMAGE_DISPLAY_METHOD getDisplayMethod () const
 
virtual void setImage (Image *value)
 
virtual void setDisplayMethod (IMAGE_DISPLAY_METHOD value)
 
- Public Member Functions inherited from nkWinUi::Component
 Component (MainSystem *parentSystem)
 
virtual ~Component ()
 
LayoutgetLayout () const
 
ThemegetTheme () const
 
nkMaths::Point getPositionInParent () const
 
nkMaths::Point getPositionInScreen () const
 
int getWidth () const
 
int getHeight () const
 
nkMaths::Rectangle getAreaInParent () const
 
nkMaths::Rectangle getAreaInScreen () const
 
virtual nkMaths::Point getBorderExtents () const
 
virtual float getBorderExtent (BORDER_KIND border) const
 
virtual int getLayoutAllowedWidth () const
 
virtual int getLayoutAllowedHeight () const
 
virtual int getLayoutAllowedOffsetX () const
 
virtual int getLayoutAllowedOffsetY () const
 
bool isInitialized () const
 
ComponentgetParentComponent () const
 
COMPONENT_TYPE getComponentType () const
 
nkMemory::StringView getComponentName () const
 
bool getVisibility () const
 
virtual nkMemory::StringView getLabel () const
 
void * getData () const
 
bool isEnabled () const
 
bool isForegroundWindow () const
 
unsigned int getZDepth () const
 
bool getVisibleOnLoad () const
 
std::function< bool(Component *)> getCloseCallback () const
 
std::function< void(Component *, bool)> getVisibilityCallback () const
 
std::function< void(Component *, const ClickEventData &)> getClickCallback () const
 
std::function< void(Component *, const WheelEventData &)> getWheelCallback () const
 
std::function< void(Component *, const KeyEventData &)> getKeyCallback () const
 
virtual LayoutsetLayout (LAYOUT_TYPE layoutType)
 
virtual void setTheme (Theme *theme)
 
virtual void setPositionInParent (nkMaths::Point position)
 
virtual void setPositionInScreen (nkMaths::Point position)
 
virtual void setSize (int width, int height)
 
virtual void setWidth (int width)
 
virtual void setHeight (int height)
 
void setMinSize (unsigned int width, unsigned int height)
 
void setMaxSize (unsigned int width, unsigned int height)
 
void setRatio (float widthOverHeight)
 
virtual void setAreaInParent (const nkMaths::Rectangle &area)
 
virtual void setAreaInScreen (const nkMaths::Rectangle &area)
 
virtual void setParentComponent (Component *parent, bool makeItVisible=true)
 
virtual void setLabel (const nkMemory::StringView &label)
 
void setComponentName (const nkMemory::StringView &name)
 
virtual void setVisibility (bool value)
 
void setData (void *data)
 
void setEnabled (bool value)
 
void setVisibleOnLoad (bool value)
 
void setCloseCallback (std::function< bool(Component *caller)> callback)
 
void setVisibilityCallback (std::function< void(Component *caller, bool visibility)> callback)
 
void setClickCallback (std::function< void(Component *caller, const ClickEventData &eventData)> callback)
 
void setWheelCallback (std::function< void(Component *caller, const WheelEventData &eventData)> callback)
 
void setKeyCallback (std::function< void(Component *caller, const KeyEventData &eventData)> callback)
 
void addChild (Component *child, bool makeItVisible=true)
 
void removeChild (Component *child)
 
void removeChild (unsigned int index)
 
ComponentgetChild (unsigned int index)
 
unsigned int getChildIndex (Component *child)
 
void unloadWithChildren ()
 
void loadWithChildren ()
 
void updateZDepth ()
 
void bringToForeground ()
 
void focusWindow ()
 
nkMaths::Point getCoordRelativeFromAbsolute (const nkMaths::Point &absCoords)
 
nkMaths::Point getCoordAbsoluteFromRelative (const nkMaths::Point &relCoords)
 
virtual void load ()=0
 
virtual void unload ()=0
 
void reload ()
 
virtual void updateWindow ()
 
nkImages::Image paintToImage (bool withFrame=false)
 
void simulateEvent (const InputDescriptor &inputDescription)
 
void onSized ()
 
virtual void exportClassToTree (nkExport::Node *rootNode) override
 
virtual void exportIntrospection (nkExport::Node *rootNode)
 
virtual void importClassFromTree (nkExport::Node *rootNode) override
 
- Public Member Functions inherited from nkExport::Exportable
 Exportable ()
 
virtual ~Exportable ()
 

Detailed Description

Allows to display an image in the Ui.

Constructor & Destructor Documentation

◆ ImageDisplay()

nkWinUi::ImageDisplay::ImageDisplay ( MainSystem parentSystem)

Constructor.

Parameters
parentSystemThe parent system in which the component will live.
Remarks
See ComponentManager::createOrRetrieve().

◆ ~ImageDisplay()

virtual nkWinUi::ImageDisplay::~ImageDisplay ( )
virtual

Destructor.

Member Function Documentation

◆ getImage()

Image* nkWinUi::ImageDisplay::getImage ( ) const
Returns
The image that the component should display.

◆ getDisplayMethod()

IMAGE_DISPLAY_METHOD nkWinUi::ImageDisplay::getDisplayMethod ( ) const
Returns
The display method used.

◆ setImage()

virtual void nkWinUi::ImageDisplay::setImage ( Image value)
virtual

Sets the image the component should display.

Parameters
valueThe image to display.

◆ setDisplayMethod()

virtual void nkWinUi::ImageDisplay::setDisplayMethod ( IMAGE_DISPLAY_METHOD  value)
virtual

Sets the method used to display the image.

Parameters
valueThe method to use.

The documentation for this class was generated from the following file: